pp108 : GetCase Instances

GetCase Instances

This API is used to retrieve all the instances of a Case.

Resource URI
v1/cases/{modelid}/instances
Request Type

HTTP GET

HTTP Header Parameters

Parameter

Description

Accepted Input Values

SAMLart

 The SAML artifact received after authentication. Refer to Login for more information on how to authenticate.

Note: The supported output formats are:

  • JSON
  • XML
Request Parameters
Parameter Description Accepted Values

modelid

 The model ID of the Case For example, if the model ID qname is com/opentext/conference/ProductLaunch then in the URL it must be provided as com.opentext.conference.ProductLaunch.
where_status_in Status of the Case model

The possible values are:

  • NEW
  • INPROGRESS
  • COMPLETED
  • ABORTED
  • SUSPENDED
  • TERMINATED

Note: Multiple values can be provided as comma separated values.
where_started_on Value from which the Case instances are started For example, the current date is 31-May-2011 and the requirement is to retrieve all the Case instances which were started from 26-May-2011. The value of this parameter must be 6 (current date - provided date). Note: The negative values are ignored.
where_due_in Count of the due days relative to the current date For example, the current date is 31-May-2011 and the requirement is to retrieve all the Case instances which are due on 02-June-2011. The value of this parameter must be 2 (provided date - current date). Note: The duration value is calculated till the midnight of the provided date. The negative values are allowed.
where_space  

The possible values are:

  • ISV
  • Organization
  • All
where_target Target to which the Case model is assigned at the design time

The possible values are:

  • Role DN
  • User DN
  • Fully Qualified Domain Name (FQDN) of the Worklist
  • FQDN of the Team
where_hierarchy  

The possible values are:

  • True
  • False
after Cursor position  
limit Cursor number of rows  
Response Parameters
Parameter Description
case_instance_identifiers Identifiers defined for a Case
case_instance_id Instance ID
case_model Unique identifier of the Case model
model_revision Model revision ID
status Status of the Case model
started_on Time when the Case started
started_by User who started the Case
last_modified_on Last modified date
last_modified_by User who last modified the Case
due_on Due date
source_type Source
source Unique identifier of the source
root_id  
Sample Response
{
   "tuple": [
      {
         "old": {
            "case_instance": {
               "case_instance_id": "db3854a9-28a4-11e3-e78d-a133edc51ded",
               "case_model": "3bd9e802-1333-11e3-e78d-21e2d7ef9de3",
               "model_revision": "0fe11726-83c9-11e3-e78d-21e2d7d2dde2",
               "status": "NEW",
               "started_on": 1382592476179,
               "started_by": "cn=cordys,cn=organizational users,o=system,cn=cordys,cn=defaultInst,o=vanenburg.com",
               "las_tmodified_on": 1382592476179,
               "last_modified_by": "cn=cordys,cn=organizational users,o=system,cn=cordys,cn=defaultInst,o=vanenburg.com",
               "due_on": null,
               "source": "9f125f83-8749-11e3-e78d-a12ecc9c5709",
               "source_type": "Web Service",
               "root_id": "db3854a9-28a4-11e3-e78d-a133edc51ded",
               "case_instance_identifiers": {
                  "any": [
                     "<?xml version=\"1.0\" encoding=\"UTF-16\"?>\n<CURRENTSTATE dataType=\"STRING\" description=\"Current Functional State\" name=\"CurrentState\" xmlns=\"http://schemas.cordys.com/casemanagement/execution/1.0\" xmlns:S=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:ns2=\"http://schemas.cordys.com/General/1.0/\">Default State<\/CURRENTSTATE>"
                  ]
               }
            }
         }
      }
   ]
}